Skip to main content

Endpoint Configuration by ID

Route

/v2/endpoint-management/configurations/{id}

Description

Retrieve a configuration module, update its metadata or JSON overrides, or delete it when no longer needed.

Methods

  • GET — fetch a configuration by ID
  • PATCH — update configuration fields
  • DELETE — delete a configuration

Inputs

ParameterTypeRequiredDescription
idstringYesConfiguration ID in the path
configurationUpdateConfigurationYes (PATCH)Fields to update (name, description, config)
fieldsstringNo (PATCH)Comma-separated list of fields to update

Request Example (PATCH)

{
"name": "High Security Sensor Config",
"description": "Updated messaging for the profile",
"config": {
"perf.cpu_limit": 75
}
}

Output (GET/PATCH)

FieldTypeDescription
typestringAlways "configurations"
sizeintegerNumber of configurations returned
resourcesarray[Configuration]Configuration object
errorsarray[Error]Any errors

Configuration Object (key fields)

FieldTypeDescription
idstringConfiguration identifier
namestringConfiguration name
descriptionstringDescription
is_defaultbooleanWhether this is the default
typestringConfiguration type
versionintegerVersion number
used_in_profilesarray[ProfileDetails]Profiles that consume this configuration
configobjectJSON payload with overrides

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response (GET)

{
"type": "configurations",
"size": 1,
"resources": [
{
"id": "config-123e4567-e89b-12d3-a456-426614174000",
"name": "High Security Sensor Config",
"description": "Updated messaging for the profile",
"is_default": false,
"type": "performance",
"version": 2,
"config": {
"perf.cpu_limit": 75
}
}
],
"errors": []
}